<!DOCTYPE html><html><head><title>Ext.dd.ScrollManager | Ext JS 4.0 Documentation</title><script type="text/javascript" src="../ext-all.js"></script><link rel="stylesheet" href="../reset.css" type="text/css"><link rel="stylesheet" href="../scrollbars.css" type="text/css"><link rel="stylesheet" href="../docs.css" type="text/css"><link id="styleCss" rel="stylesheet" href="../style.css" type="text/css"><script type="text/javascript" src="../prettify.js"></script><link rel="stylesheet" href="../prettify.css" type="text/css"><!-- link(rel: 'stylesheet', href: req.baseURL + '/css/ext4.css', type: 'text/css')--><link rel="shortcut icon" type="image/ico" href="../favicon.ico"><!--[if IE]>
<style type="text/css">.head-band { display: none; }
.header { border: 0; top: 0; left: 0px; background: url(../header.gif) repeat-x; }
.doc-tab .members .member a.more { background-color: #efefef; }
</style><link rel="stylesheet" href="/new/css/ie.css" type="text/css"><![endif]-->
</head><body id="ext-body" class="iScroll"><div id="notice" class="notice">For up to date documentation and features, visit 
<a href="http://docs.sencha.com/ext-js/4-0">http://docs.sencha.com/ext-js/4-0</a></div><div class="wrapper"><div class="head-band"></div><div class="header"><h2><a href="../index.html">Sencha Documentation</a></h2></div><div id="search"><form><input type="text" placeholder="Search" id="search-field" autocomplete="off" name="q"></form><div id="search-box"></div></div><div id="treePanel"></div><div id="container"><script type="text/javascript">

    req = {
        liveURL: '.',
        standAloneMode: true,
        origDocClass: 'Ext.dd.ScrollManager',
        docClass: 'Ext.dd.ScrollManager',
        docReq: 'Ext.dd.ScrollManager',
        version: '4.0',
        baseURL: '.',
        baseDocURL: '.',
        baseProdURL: '.'
    };

    clsInfo = {};



</script>

<script type="text/javascript" src="../search.js"></script>
<!--script type="text/javascript" src="/new/javascripts/app/examples.js"></script-->
<script type="text/javascript" src="../class_tree.js"></script>
<script type="text/javascript" src="../class_doc.js"></script>
<script type="text/javascript">
    req.source = 'ScrollManager.html#Ext-dd.ScrollManager';
    clsInfo = {"methods":["refreshCache","register","unregister"],"cfgs":[],"properties":["animDuration","animate","ddGroup","frequency","hthresh","increment","vthresh"],"events":[],"subclasses":[]};
    Ext.onReady(function() {
        Ext.create('Docs.classPanel');
    });
</script><div id="top-block" class="top-block"><h1 id="clsTitle" class="cls"><a href="../source/ScrollManager.html#Ext-dd.ScrollManager" target="_blank">Ext.dd.ScrollManager</a></h1></div><div id="docContent"><div id="doc-overview-content"><div class="lft"><p>Provides automatic scrolling of overflow regions in the page during drag operations.</p>


<p>The ScrollManager configs will be used as the defaults for any scroll container registered with it,
but you can also override most of the configs per scroll container by adding a
<tt>ddScrollConfig</tt> object to the target element that contains these properties: <a href="Ext.dd.ScrollManager.html#hthresh" rel="Ext.dd.ScrollManager#hthresh" class="docClass">hthresh</a>,
<a href="Ext.dd.ScrollManager.html#vthresh" rel="Ext.dd.ScrollManager#vthresh" class="docClass">vthresh</a>, <a href="Ext.dd.ScrollManager.html#increment" rel="Ext.dd.ScrollManager#increment" class="docClass">increment</a> and <a href="Ext.dd.ScrollManager.html#frequency" rel="Ext.dd.ScrollManager#frequency" class="docClass">frequency</a>.  Example usage:
<pre class="prettyprint"><code>var el = Ext.get('scroll-ct');
el.ddScrollConfig = {
    vthresh: 50,
    hthresh: -1,
    frequency: 100,
    increment: 200
};
Ext.dd.ScrollManager.register(el);
</code></pre>
<b>Note: This class uses "Point Mode" and is untested in "Intersect Mode".</b>

<div class="members"><div class="m-properties"><a name="properties"></a><div class="definedBy">Defined By</div><h3 class="prp p">Properties</h3><div id="property-animDuration" class="member f ni"><a href="Ext.dd.ScrollManager.html#property-animDuration" rel="property-animDuration" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-property-animDuration" class="viewSource">view source</a></div><a name="animDuration"></a><a name="property-animDuration"></a><a href="Ext.dd.ScrollManager.html#" rel="property-animDuration" class="cls expand">animDuration</a><span> : Number</span></div><div class="description"><div class="short"><p>The animation duration in seconds -
MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)</p>
</div><div class="long"><p>The animation duration in seconds -
MUST BE less than Ext.dd.ScrollManager.frequency! (defaults to .4)</p>
</div></div></div><div id="property-animate" class="member ni"><a href="Ext.dd.ScrollManager.html#property-animate" rel="property-animate" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-property-animate" class="viewSource">view source</a></div><a name="animate"></a><a name="property-animate"></a><a href="Ext.dd.ScrollManager.html#" rel="property-animate" class="cls expand">animate</a><span> : Boolean</span></div><div class="description"><div class="short"><p>True to animate the scroll (defaults to true)</p>
</div><div class="long"><p>True to animate the scroll (defaults to true)</p>
</div></div></div><div id="property-ddGroup" class="member ni"><a href="Ext.dd.ScrollManager.html#property-ddGroup" rel="property-ddGroup" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-property-ddGroup" class="viewSource">view source</a></div><a name="ddGroup"></a><a name="property-ddGroup"></a><a href="Ext.dd.ScrollManager.html#" rel="property-ddGroup" class="cls expand">ddGroup</a><span> : String</span></div><div class="description"><div class="short">The named drag drop group to which this container belongs (defaults to undefined).
If a ddGroup is specified, then co...</div><div class="long"><p>The named drag drop <a href="Ext.dd.DragSource.html#ddGroup" rel="Ext.dd.DragSource#ddGroup" class="docClass">group</a> to which this container belongs (defaults to undefined).
If a ddGroup is specified, then container scrolling will only occur when a dragged object is in the same ddGroup.</p>
</div></div></div><div id="property-frequency" class="member ni"><a href="Ext.dd.ScrollManager.html#property-frequency" rel="property-frequency" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-property-frequency" class="viewSource">view source</a></div><a name="frequency"></a><a name="property-frequency"></a><a href="Ext.dd.ScrollManager.html#" rel="property-frequency" class="cls expand">frequency</a><span> : Number</span></div><div class="description"><div class="short"><p>The frequency of scrolls in milliseconds (defaults to 500)</p>
</div><div class="long"><p>The frequency of scrolls in milliseconds (defaults to 500)</p>
</div></div></div><div id="property-hthresh" class="member ni"><a href="Ext.dd.ScrollManager.html#property-hthresh" rel="property-hthresh" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-property-hthresh" class="viewSource">view source</a></div><a name="hthresh"></a><a name="property-hthresh"></a><a href="Ext.dd.ScrollManager.html#" rel="property-hthresh" class="cls expand">hthresh</a><span> : Number</span></div><div class="description"><div class="short">The number of pixels from the right or left edge of a container the pointer needs to be to
trigger scrolling (default...</div><div class="long"><p>The number of pixels from the right or left edge of a container the pointer needs to be to
trigger scrolling (defaults to 25)</p>
</div></div></div><div id="property-increment" class="member ni"><a href="Ext.dd.ScrollManager.html#property-increment" rel="property-increment" class="expand more"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-property-increment" class="viewSource">view source</a></div><a name="increment"></a><a name="property-increment"></a><a href="Ext.dd.ScrollManager.html#" rel="property-increment" class="cls expand">increment</a><span> : Number</span></div><div class="description"><div class="short"><p>The number of pixels to scroll in each scroll increment (defaults to 100)</p>
</div><div class="long"><p>The number of pixels to scroll in each scroll increment (defaults to 100)</p>
</div></div></div><div id="property-vthresh" class="member ni"><a href="Ext.dd.ScrollManager.html#property-vthresh" rel="property-vthresh" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-property-vthresh" class="viewSource">view source</a></div><a name="vthresh"></a><a name="property-vthresh"></a><a href="Ext.dd.ScrollManager.html#" rel="property-vthresh" class="cls expand">vthresh</a><span> : Number</span></div><div class="description"><div class="short">The number of pixels from the top or bottom edge of a container the pointer needs to be to
trigger scrolling (default...</div><div class="long"><p>The number of pixels from the top or bottom edge of a container the pointer needs to be to
trigger scrolling (defaults to 25)</p>
</div></div></div></div><div class="m-methods"><a name="methods"></a><div class="definedBy">Defined By</div><h3 class="mth p">Methods</h3><div id="method-refreshCache" class="member f ni"><a href="Ext.dd.ScrollManager.html#method-refreshCache" rel="method-refreshCache" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-method-refreshCache" class="viewSource">view source</a></div><a name="refreshCache"></a><a name="method-refreshCache"></a><a href="Ext.dd.ScrollManager.html#" rel="method-refreshCache" class="cls expand">refreshCache</a> : void</div><div class="description"><div class="short"><p>Manually trigger a cache refresh.</p>
</div><div class="long"><p>Manually trigger a cache refresh.</p>
<h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
</li></ul></div></div></div><div id="method-register" class="member ni"><a href="Ext.dd.ScrollManager.html#method-register" rel="method-register" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-method-register" class="viewSource">view source</a></div><a name="register"></a><a name="method-register"></a><a href="Ext.dd.ScrollManager.html#" rel="method-register" class="cls expand">register</a>(
<span class="pre">Mixed/Array el</span>)
 : void</div><div class="description"><div class="short"><p>Registers new overflow element(s) to auto scroll</p>
</div><div class="long"><p>Registers new overflow element(s) to auto scroll</p>
<h3 class="pa">Parameters</h3><ul><li><span class="pre">el</span> : Mixed/Array<div class="sub-desc"><p>The id of or the element to be scrolled or an array of either</p>
</div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
</li></ul></div></div></div><div id="method-unregister" class="member ni"><a href="Ext.dd.ScrollManager.html#method-unregister" rel="method-unregister" class="expand more ar"><span>&nbsp;</span></a><div class="title"><div class="meta"><a href="Ext.dd.ScrollManager.html" class="definedIn docClass">Ext.dd.ScrollManager</a><br/><a href="../source/ScrollManager.html#Ext-dd.ScrollManager-method-unregister" class="viewSource">view source</a></div><a name="unregister"></a><a name="method-unregister"></a><a href="Ext.dd.ScrollManager.html#" rel="method-unregister" class="cls expand">unregister</a>(
<span class="pre">Mixed/Array el</span>)
 : void</div><div class="description"><div class="short"><p>Unregisters overflow element(s) so they are no longer scrolled</p>
</div><div class="long"><p>Unregisters overflow element(s) so they are no longer scrolled</p>
<h3 class="pa">Parameters</h3><ul><li><span class="pre">el</span> : Mixed/Array<div class="sub-desc"><p>The id of or the element to be removed or an array of either</p>
</div></li></ul><h3 class="pa">Returns</h3><ul><li><span class="pre">void</span>&nbsp; &nbsp;
</li></ul></div></div></div></div></div></div></div><div id="pageContent"></div></div></div></div></body></html>